Skip to content

docs: update Mynth community adapter#828

Merged
AlemTuzlak merged 1 commit into
TanStack:mainfrom
mynthio:update-mynth-adapter-doc
Jun 24, 2026
Merged

docs: update Mynth community adapter#828
AlemTuzlak merged 1 commit into
TanStack:mainfrom
mynthio:update-mynth-adapter-doc

Conversation

@50BytesOfJohn

@50BytesOfJohn 50BytesOfJohn commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

🎯 Changes

Updates the Mynth community adapter docs to match the current adapter. Covers image-to-image with content-part prompts, the renamed modelOptions (negativePrompt, magicPrompt, rating), the new MYNTH_IMAGE_INPUT_MODELS list, the destination config option, and the public models endpoint. Also drops the alpha notice now that Mynth is in public beta.

Docs-only change for a community adapter.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated the Mynth adapter guide to reflect its current beta status and revised options.
    • Added clearer examples for image generation settings, including negative prompts, magic prompts, and rating controls.
    • Expanded guidance for image-to-image support, model capabilities, and request option behavior.
    • Documented the live models endpoint and clarified the available model lists for type-safe usage.
    • Added reference details for destination handling and image input model support.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The Mynth community adapter documentation is updated from alpha to public beta positioning. The modelOptions section gains field mapping documentation, image-to-image usage guidance via content-part prompts, and updated examples. The Models section introduces a live /models endpoint, and the API reference adds config.destination?, MYNTH_IMAGE_INPUT_MODELS, and MynthImageInputModel.

Changes

Mynth Adapter Documentation Update

Layer / File(s) Summary
Intro, description, and compatibility note
docs/community-adapters/mynth.md
Top-level description sentence is rewritten to name the adapter's scope and model families. Introductory paragraph is replaced to reflect public beta status, typed model IDs, normalized results, image-to-image support, and modelOptions. A new compatibility note specifies @tanstack/ai 0.34+.
modelOptions examples, field mappings, and image-to-image usage
docs/community-adapters/mynth.md
The generateImage() modelOptions example is updated to use negativePrompt, magicPrompt, and rating: true. Explanatory notes are rewritten to document field aliases (rating/contentRating), promptStructured expansion and override behavior, size shorthand vs modelOptions.size, destination semantics, and the full image-to-image workflow using content-part prompts with role/intent mapping and modelOptions.inputs.
Live models endpoint, capabilities list, and API reference
docs/community-adapters/mynth.md
The Models section is reworked to introduce the https://api.mynth.io/models endpoint with a fetch example and response shape, clarifying that exported lists are a fixed snapshot for type safety. Image-to-image is added to the supported capabilities list. mynthImage() API reference gains config.destination?. MYNTH_IMAGE_INPUT_MODELS and MynthImageInputModel are documented.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hop hop, the docs have grown!
From alpha seeds to beta sown,
Image inputs find their place,
negativePrompt joins the race.
Live models at an endpoint gleam —
A rabbit's tidy documentation dream! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and clearly summarizes the main docs update for the Mynth community adapter.
Description check ✅ Passed The description follows the required template and covers the change summary, checklist, and release impact.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/community-adapters/mynth.md (1)

194-205: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Add a server-side companion snippet for the models endpoint section.

This section currently shows only client consumption (fetch). Please add a server endpoint example (that proxies/caches https://api.mynth.io/models) plus client consumption against that endpoint so both sides are documented.

As per coding guidelines: "Show both server and client sides of the coin when a doc spans both; include snippets for both the server endpoint AND client consumption".

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/community-adapters/mynth.md` around lines 194 - 205, The Models endpoint
section only shows client-side fetch usage, so add a server-side companion
example and a matching client example. Update the documented snippet around the
models endpoint to include a server endpoint that proxies and/or caches the
Mynth API response, then show client consumption against that server endpoint
instead of calling https://api.mynth.io/models directly. Keep the examples
together so the Models endpoint section clearly documents both server and client
sides.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@docs/community-adapters/mynth.md`:
- Around line 194-205: The Models endpoint section only shows client-side fetch
usage, so add a server-side companion example and a matching client example.
Update the documented snippet around the models endpoint to include a server
endpoint that proxies and/or caches the Mynth API response, then show client
consumption against that server endpoint instead of calling
https://api.mynth.io/models directly. Keep the examples together so the Models
endpoint section clearly documents both server and client sides.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e9889dea-5bfd-4074-a4db-5086b07ab40f

📥 Commits

Reviewing files that changed from the base of the PR and between f3144a6 and 75a6dc9.

📒 Files selected for processing (1)
  • docs/community-adapters/mynth.md

@nx-cloud

nx-cloud Bot commented Jun 24, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 75a6dc9

Command Status Duration Result
nx run-many --targets=build --exclude=examples/... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2026-06-24 15:50:13 UTC

@pkg-pr-new

pkg-pr-new Bot commented Jun 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@tanstack/ai

npm i https://pkg.pr.new/@tanstack/ai@828

@tanstack/ai-angular

npm i https://pkg.pr.new/@tanstack/ai-angular@828

@tanstack/ai-anthropic

npm i https://pkg.pr.new/@tanstack/ai-anthropic@828

@tanstack/ai-client

npm i https://pkg.pr.new/@tanstack/ai-client@828

@tanstack/ai-code-mode

npm i https://pkg.pr.new/@tanstack/ai-code-mode@828

@tanstack/ai-code-mode-skills

npm i https://pkg.pr.new/@tanstack/ai-code-mode-skills@828

@tanstack/ai-devtools-core

npm i https://pkg.pr.new/@tanstack/ai-devtools-core@828

@tanstack/ai-elevenlabs

npm i https://pkg.pr.new/@tanstack/ai-elevenlabs@828

@tanstack/ai-event-client

npm i https://pkg.pr.new/@tanstack/ai-event-client@828

@tanstack/ai-fal

npm i https://pkg.pr.new/@tanstack/ai-fal@828

@tanstack/ai-gemini

npm i https://pkg.pr.new/@tanstack/ai-gemini@828

@tanstack/ai-grok

npm i https://pkg.pr.new/@tanstack/ai-grok@828

@tanstack/ai-groq

npm i https://pkg.pr.new/@tanstack/ai-groq@828

@tanstack/ai-isolate-cloudflare

npm i https://pkg.pr.new/@tanstack/ai-isolate-cloudflare@828

@tanstack/ai-isolate-node

npm i https://pkg.pr.new/@tanstack/ai-isolate-node@828

@tanstack/ai-isolate-quickjs

npm i https://pkg.pr.new/@tanstack/ai-isolate-quickjs@828

@tanstack/ai-mcp

npm i https://pkg.pr.new/@tanstack/ai-mcp@828

@tanstack/ai-ollama

npm i https://pkg.pr.new/@tanstack/ai-ollama@828

@tanstack/ai-openai

npm i https://pkg.pr.new/@tanstack/ai-openai@828

@tanstack/ai-openrouter

npm i https://pkg.pr.new/@tanstack/ai-openrouter@828

@tanstack/ai-preact

npm i https://pkg.pr.new/@tanstack/ai-preact@828

@tanstack/ai-react

npm i https://pkg.pr.new/@tanstack/ai-react@828

@tanstack/ai-react-ui

npm i https://pkg.pr.new/@tanstack/ai-react-ui@828

@tanstack/ai-solid

npm i https://pkg.pr.new/@tanstack/ai-solid@828

@tanstack/ai-solid-ui

npm i https://pkg.pr.new/@tanstack/ai-solid-ui@828

@tanstack/ai-svelte

npm i https://pkg.pr.new/@tanstack/ai-svelte@828

@tanstack/ai-utils

npm i https://pkg.pr.new/@tanstack/ai-utils@828

@tanstack/ai-vue

npm i https://pkg.pr.new/@tanstack/ai-vue@828

@tanstack/ai-vue-ui

npm i https://pkg.pr.new/@tanstack/ai-vue-ui@828

@tanstack/openai-base

npm i https://pkg.pr.new/@tanstack/openai-base@828

@tanstack/preact-ai-devtools

npm i https://pkg.pr.new/@tanstack/preact-ai-devtools@828

@tanstack/react-ai-devtools

npm i https://pkg.pr.new/@tanstack/react-ai-devtools@828

@tanstack/solid-ai-devtools

npm i https://pkg.pr.new/@tanstack/solid-ai-devtools@828

commit: 75a6dc9

@AlemTuzlak AlemTuzlak merged commit cefeb52 into TanStack:main Jun 24, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants